/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.olingo.ext.proxy.api;

import java.util.Map;

/**
 * Sort option for queries.
 */
public class Sort implements Map.Entry<String, Sort.Direction> {

  /**
   * Enumeration for sort directions.
   */
  public enum Direction {

    ASC,
    DESC;

    @Override
    public String toString() {
      return name().toLowerCase();
    }
  }
  private final String key;

  private Direction value;

  public Sort(final String key, final Direction value) {
    this.key = key;
    this.value = value;
  }

  @Override
  public String getKey() {
    return this.key;
  }

  @Override
  public Direction getValue() {
    return this.value;
  }

  @Override
  public Direction setValue(final Direction value) {
    this.value = value;
    return this.value;
  }
}
